Setting up integration to store data into Pega using realtime REST JSON

1. On the exercise system landing page, click Pega CRM suite to log in to Customer Decision Hub.
2. Log in to Dev Studio as the system architect with User name SystemArchitect and Password rules.
3. In the header of Dev Studio, click Application: Customer Decision Hub > Definition to open the application definition.
   
4. On the Edit Application: Customer Decision Hub rule form, in the Application rulesets section, click + Add ruleset.
5. Click and hold the empty row then drag it from the bottom to the top of the ruleset stack.
   
6. Enter the name of the ruleset as MyOrgInt:01-01, then click the target icon to create a new ruleset version.
   
   Tip: As best practice, use the name of your organization or the name of the tool within your organization that you are integrating with the Pega side, followed by the letters Int (short for integration). Follow the name of the ruleset with :01-01 which indicates the version of the ruleset.

7. In the upper-right corner, click Create and open.
   
8. On the Edit Ruleset: MyOrgInt tab, click Save.
9. Close the Edit Ruleset: MyOrgInt tab and on the Edit Application: Customer Decision Hub tab, click Save to save your application definition rule with the newly defined ruleset.
   

1. On the exercise system landing page, click CloudBeaver to log in to the CloudBeaver web application.
   
2. In the navigation pane of CloudBeaver, click Pega, and then, in the header of CloudBeaver click SQL to open a new tab.
   
3. Define a new table in the database to store the integration data. The table must be created in the ExternalMKTData schema of Customer Decision Hub. For the purposes of this exercise, use the following SQL script:

   -- Table: externalmktdata.sample -- DROP TABLE externalmktdata.sample; CREATE TABLE externalmktdata.sample ( customerid character varying(255) COLLATE pg_catalog."default" NOT NULL, sampleinteger integer, sampledecimal numeric(3,2), CONSTRAINT sampletable_pkey PRIMARY KEY (customerid) ) WITH ( OIDS = FALSE ) TABLESPACE pg_default; ALTER TABLE externalmktdata.sample OWNER to pega;

4. Press CTRL + ENTER on your keyboard to run the query and see the results.
5. Log in to Dev Studio as the system architect with User name SystemArchitect and Password rules.
6. Create a Database Admin Table instance rule to map your class to the table that you created in Task 2, step 3.
   1. In the header of Dev Studio, click Create > SysAdmin > Database Table.
   2. In the Database Table short description, enter MyOrg-Data-Sample as a description for the table.
   3. In the Class Name, enter MyOrg-Data-Sample as the name of the data class.
      Tip: The Class name should be named with the following convention: OrgName-Data-TypeOfData
   4. Click Create and Open.
   5. In the Database field, enter ExternalMKTData.
   6. In the Table name field, enter sample as the name of the table that was created for you.
   7. On the header of the rule form, click [Edit] to update the Associated RuleSet to the MyOrgInt rule set that you created in Task 1, step 6, and then click OK.
      
   8. In the upper-right corner, click Save.
      Caution: Do not click the Test Connectivity button until you create the data class. This helps to automatically configure the class and database table mapping.

1. In the header of Dev Studio, click Create > SysAdmin > Class to create a new class.
   1. In the Class Record Configuration section, in the Label field, enter MyOrg Data as a short description for your class.
   2. In the Class Name field, enter MyOrg-Data-Sample as the unique name for your class.
      Tip: Use the following convention: OrgName-Data-TypeOfData
   3. In the Context section, select the Customer Decision Hub radio button.
   4. In the Add to ruleset list, select the MyOrgInt ruleset that you created in Task 1, step 6.
   5. In the upper-right corner, click Create and open.
      

2. On the General tab of the class form, select the class type, and then define the class settings for the new class:
   1. In the Select class type list, select Concrete.
   2. In the Settings section, in the Created in version field, enter 01-01-01.
   3. In the Settings section, in the This class list, select does not belong to a class group.
   4. In the Keys section, in the Name field enter .CustomerID
   5. In the Caption field, enter CustomerID.
   6. In the Class inheritance section, in the Parent Class (Directed) field, enter PegaMKT-Data-.
      
   7. On the History tab, in the Description field enter Sample class, and in the Usage field, enter Sample usage.
      
   8. In the upper-right corner, click Save.
3. In the header of Dev Studio, click the tab for the Database Table rule that you created in Task 2, step 6.
   1. In the upper-right corner, click Save.
   2. In the Database section, click Test connectivity.
      
   3. Confirm that the data class is mapped to the correct database table.
      
      Caution: Issues with the connection are resolved when the properties are created.

4. In the header of Dev Studio, switch between the open tabs to the data class that you created in Task 3.
5. At the top of the Edit class rule form, click the down arrow and then select View in data designer to define the data model that reflects the data that you want to store in the Pega application.
   
6. In the upper-right corner, click Add field to define a new property.
   
   1. In the Field name field enter the name of the property as Sample integer.
      Tip: As best practice, use sentence case when naming fields: capitalize the first letter of the first word, and then lowercase for the rest of the words. For example, Sample integer.
   2. In the Type list, select Integer as the type of field.
   3. Optional: To add additional fields, click Submit & add another.
      
      Caution: You do not need to create the CustomerID, as this property already exists in the data model.
   4. Optional: To create additional fields, repeat steps 6a to 6b.
      For this exercise, add another field with Field name Sample decimal and Type Decimal.
   5. Click Submit.
   6. On the Data Type: MyOrg Data page, click Save.
      

7. Create a new data set rule to connect to the database table:
   1. In the header of Dev Studio, click Create > Data model > Data set.
   2. On the Create Data Set form, in the Label field, enter Sample as the name for the data set.
   3. In the Type list, select Database table.
   4. In the Context section, in the Apply to field, enter or select MyOrg-Data-Sample as the data class.
   5. In the Context section, in the Add to ruleset list, select MyOrgInt as the ruleset.
   6. Click Create and open.
      
   7. In the upper-right corner, click Save.
      
      Tip: This data set can be used to query the records stored in the database table. Currently, there are no records in the database table.

1. In the header of Dev Studio, click Create > SysAdmin > Class to create a new integration class.
   1. In the Class Record Configuration section, in the Label field, enter MyOrg Integration as a short description.
   2. In the Class Name field, enter MyOrg-Int-Sample as a unique name for your integration class.
      Tip: Use the following naming convention for integration class names: OrgName-Int-TypeOfData
   3. In the Context section, select the Customer Decision Hub radio button.
   4. In the Add to ruleset list, select the MyOrgInt ruleset that you created in Task 1, step 6.
   5. Click Create and open.
      

2. On the General tab of the class form, select a class type, and then define the class settings for the new class:
   1. In the Select class type list, select Abstract.
   2. In the Settings section, in the Created in version field, enter 01-01-01.
   3. In the Class inheritance section, in the Parent Class (Directed) field, enter Int-PegaCDH.
      
   4. On the History tab, in the Description field enter Sample class, and in the Usage field, enter Sample usage.
   5. In the upper-right corner, click Save.
3. At the top of the Edit class rule form, click the down arrow and then select View in data designer to define the data model that reflects the data you want to store on the Pega side.
   
   Caution: As a best practice, the fields should map letter-for-letter to the attributes that are passed in through the service call to the Pega application as part of the integration.

4. In the upper-right corner, click Add field to define properties according to the data model.
   1. Add the following fields:

      Field Name	Field Type
      Customer ID	Text
      Sample integer	Integer
      Sample decimal	Decimal

   2. Click Submit.
      
   3. On the Data Type: MyOrg Integration page, click Save.

5. Create a page property in the integration class that maps to the data class that you created in Task 3, step 2.
   1. In the header of Dev Studio, click Create > Data Model > Property.
   2. In the Label field, enter the name of the page property as SamplePage.
      Tip: As a best practice, the name of a property should start with the type of data that the property represents and end with the word Page.
   3. In the Context section, select the application.
   4. In the Apply to field, enter MyOrg-Int-Sample as the integration class.
   5. In the Add to ruleset list, select the ruleset that you created in Task 1.
   6. Click Create and open.
      
   7. In the Property type section, click change, and then select Single Page.
      
   8. In the Page definition field, enter the MyOrg-Data-Sample data class that you created in Task 3.
      
   9. In the upper-right corner, click Save.
      Caution: If the JSON structure coming into your REST service is not flat and contains nested structures, you must create multiple integration classes with corresponding page or page list properties in your top-most integration class, so that when you look at the structure of your clipboard page and properties inside the integration class, it matches the structure of the JSON. For example:
      
      {
      "CustomerID" : "12345",
      "FirstName" : "John",
      "LastName" : "Doe",
      "AddressDetails" :
      [
      {"AddressLine1" : "30 Milk St",
      "City" : "Boston",
      "State" : "MA",
      "Country" : "US"}
      ],
      "CommunicationDetails":
      [
      { "HomePhoneNumber" : "7812224321",
      "CellphoneNumber" : "7810807654",
      "Email" : "[email protected]" }
      ]
      }
      
      For this JSON, you create 3 integration classes. One for the Customer, one for AddressDetails, and one for CommunicationsDetails. Inside the Customer integration class, you define a page property that has the Applies to class of your AddressDetails integration class and another page property with the Applies to class of your CommunicationDetails integration class.
      The names of the page properties should have the same name as your embedded complex data structure. In this exercise, these are AddressDetails and CommunicationDetails respectively. Each of your integration classes then needs corresponding properties that map one-to-one to the fields defined in the embedded data structure. Because you are flattening everything into your Data class, all the properties in each of these integration classes must be flattened into your data class.

1. In the header of Dev Studio, click Create > Integration-Resources > Service Package, to create a service package.
   1. On the Create Service Package page, in the Service Package short description field, enter Sample Service to describe the purpose of your service package.
   2. In the Service Package Name field, specify Sample as the name of your service package.
   3. Click Create and open.
      
2. On the Edit Service Package page, on the Context tab, configure the following settings:
   1. In the Processing mode list, select Stateless.
   2. In the Service access group list, enter or select PegaNBAM:Agents.
   3. Clear the Requires authentication checkbox.
   4. In the header of the rule form, click [Edit] to update the Associated RuleSet to the MyOrgInt rule set that you created in Task 1, step 6, and then click OK.
   5. In the upper-right corner, click Save.
      
      Caution: Customers using this integration service in production will need to enable authentication and set up either Basic authentication or OAuth 2.0 authentication.

3. In the header of Dev Studio, click Create > Integration-Services > Service REST to create a new REST service.
4. In the Service REST Record Configuration section, configure the following settings:
   1. In the Service name field, enter SampleService as a label for the Service REST rule.
   2. In the Service package name list, enter or select the Sample service package that you created in Task 5, step 2.
   3. In the Service version field, enter v1.
   4. To the right of the URI Template field, click Build URI to create a new URI template.
      
      Tip: You use Build URI to map a resource URI to a service REST rule. Use a URI template to define multiple URIs with similar structures. Templates contain a path and a query.
   5. In the Build URI Template window, click + Add.
   6. In the URI component column, enter Example as the name of the URI component.
   7. In the URI component type list, select Literal.
      Tip: Literal: A literal value does not change. For example, if you are configuring a service endpoint URL to fetch the next stage of a case, the literal value could be /cases.
      Variable: A variable value can change depending on the information that the service is fetching. For example, for a service endpoint that is fetching the next stage of a case, {caseID} is a variable value. The case ID can change based on the case for which you are fetching the next stage.
   8. Click Submit.
      
   9. Click Create and open.
      

5. On the Edit Service REST rule form, on the Service tab, configure the following settings:
   1. In the Resource properties section, in the Resource list, enter or select MyOrg-Int-Sample, the integration class that you created in Task 4, step 2.
   2. On the Service tab, select the Enable checkbox to enable the Lightweight clipboard mode.
      
6. On the Methods tab, configure the following settings:
   1. Expand the POST section to define a service activity to run when the POST method is called.
   2. In the Implementation field, enter SampleServiceActivity as the name for the service activity, and then click the target icon.
      
7. In the upper-right corner, click Create and open to create the new service activity.
   
8. On the Edit Activity rule form, configure the following settings:
   1. On the Pages & Classes tab, add .SamplePage in the Page name field, and MyOrg-Data-Sample in the Class field, which you defined in Task 3, step 2.
      
      Tip: If the service request JSON is not flat, flatten all the data onto the page that you defined above in Task 5, step 8.a by copying the data from the embedded structures onto that page.
   2. On the Steps tab, in the Method list, enter or select DataSet-Execute.
   3. In the Step page list , enter or select the page .SamplePage, that you defined on the Pages & Classes tab.
   4. Expand the Method field to display its properties.
   5. In the Method Parameters section, in the Data set list, enter Sample, the data set that you defined in Task 3, step 7.
   6. In the Operation list, select Save.
   7. Select Insert new and overwrite existing records.
      
   8. In the upper-right corner, click Save.
   9. In the upper-right corner, click Close to return to the Service REST rule.

9. On the Methods tab, in the Message data section, configure the following settings:
   1. In the Map to list, select JSON.
   2. In the Map to key field, enter or select the .SamplePage page that you created as part of Task 4, step 5.
   3. In the Mapping method list, select Use fast processing.
      
   4. In the upper-right corner, click Save.

1. In the header of Dev Studio, click Configure > Application > Inventory > Relevant Records to mark your properties as relevant for decisioning.
   
2. On the Application: Inventory landing page, in the Class name field, enter the MyOrg-Data-Sample data class that you created in Task 3, step 2.
   1. Select the Show inherited relevant records for the class checkbox.
   2. For all properties or When rules that are listed that have a different Applies to class than the data class created in Task 3, step 2, click the More icon at the end of the row, and then select Mark inactive for the current class.
      
      Tip: Click Add records to add new relevant records for properties that are not marked as relevant.
      To add a new relevant record:
      1. In the Type field, select Property,
      2. In the Record name field, enter the properties in your data class.
      3. In the Associate categories field, enter Eligibility, then enter Applicability.
      4. Click Submit.
   3. For all properties defined in the Data class, click the More icon at the end of their rows, select Associate to categories, and then select Eligibility and Applicability.
      
   4. Click OK.
      Caution: Review all the relevant records and ensure that you include all the required properties and do not have any properties or when rules that should not be marked relevant. If there are any, mark them as inactive.
   5. In the upper-right corner, click Close.

Before packaging the created artifacts and making the package available to others, you must unit test the configuration.

1. Open the Service REST rule that you created in Task 5, step 5, to display the Service endpoint URL.
   
   Caution: In the Service endpoint URL, update http to https when making the REST call.

2. Use an API testing tool, such as Postman, to invoke the service with a JSON request.
   1. Choose the POST method.
   2. Enter the Service URL: https://env.XXXXXX.pegaenablement.com/prweb/api/Sample/v1/Example.
   3. Enter the JSON payload:

      { "CustomerID":"12", "SampleInteger":3, "SampleDecimal":2.5 }

   4. Send the request.
      
   5. Confirm that you receive a valid response. For example, 200 OK.

3. Open the Data set rule that you created in Task 3, step 7, to confirm that the record sent via the service call is stored in the database table.
   1. Click Action > Run to browse the data set.
      
   2. In the Run Data Set window, in the Operation list, select Browse and then click Run.
      
   3. Confirm that the record is retrieved from the database table.
      
   4. Optional: You can also directly query the database table from CloudBeaver.